vcIntEnumProperty

Typed property that holds a value with a description, limited by a pre-defined set of values.

See in: Overview

Module: vcCore

Children: vcBackfaceMode, vcBitmapFileFormat, vcBitmapFormat, vcChartDataType, vcChartTileType, vcChartType, ... (see more)

vcBackfaceMode
vcBitmapFileFormat
vcBitmapFormat
vcChartDataType
vcChartTileType
vcChartType
vcClippingMode
vcCollisionTestMethod
vcConnectorTestLocation
vcConnectorType
vcEdgeShadingMode
vcEnumPropertyType
vcExpressionPropertyType
vcFocusModeDynamicSetting
vcJointAxis
vcJointServoType
vcJointType
vcLayoutItemType
vcLightType
vcLimitPropertyType
vcListPropertyType
vcMaterialDepthComparison
vcMaterialInheritance
vcMaterialOpacityType
vcMaterialRenderOrder
vcMatrixFormat
vcMenuTool
vcMessageBoxButton
vcMessageBoxImage
vcMessageBoxResult
vcMessageType
vcMoveType
vcNodeListEntryScope
vcNodeListEntryType
vcNodeSynchronizationType
vcNodeTreeScope
vcPackFolderState
vcPdfExportLevel
vcPropertyType
vcQuantityKind
vcReferencePropertyType
vcRenderShadingMode
vcSimNodeType
vcSimulationLevel
vcSimulationState
vcStepPropertyType
vcSweptVolumeDecompositionType
vcSweptVolumeMethod
vcVolumeDetectorTestMethod

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
AllowedValues	list	RW	Gets or sets a list of allowed values for property.
Type	vcEnumPropertyType	R	Gets the type of the property.
Value	Integer	RW	Gets or sets the property value.
ValueDescription	String	R	Gets the description of the current property value.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
waitFor	object	Integer OR None value, Optional Keyword[waitTrigger = Boolean]	Blocks script execution until vcProperty.Value is equal to the "value". See more This function returns an awaitable task. It must be awaited. Parameters: value (object): Value that is used for comparison. When the value is equal to vcProperty.Value, the task completes. Optional: waitTrigger (boolean): False by default. When waitTrigger is True, the task will wait for the value to change first, before comparing it against "value". Otherwise, the comparison is done immediately and when the values match, the task will complete without blocking the script. Returns: Awaitable[List]: The task instance. When awaited, returns a list of event arguments that the event has been triggered with.
waitForNot	object	Integer OR None value, Optional Keyword[waitTrigger = Boolean]	Blocks script execution until vcProperty.Value is not equal to the "value". See more This function returns an awaitable task. It must be awaited. Parameters: value (object): Value that is used for comparison. When the value is not equal to vcProperty.Value, the task completes. Optional: waitTrigger (boolean): False by default. When waitTrigger is True, the task will wait for the value to change first, before comparing it against "value". Otherwise, the comparison is done immediately and when the values do not match, the task will complete without blocking the script. Returns: Awaitable[List]: The task instance. When awaited, returns a list of event arguments that the event has been triggered with.